/**
 * Copyright (c) 2013-2022 Nikita Koksharov
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.redisson.connection;

import org.redisson.api.NodeType;
import org.redisson.client.RedisClient;
import org.redisson.misc.RedisURI;
import org.redisson.pubsub.PublishSubscribeService;

import java.net.InetSocketAddress;
import java.util.Collection;
import java.util.concurrent.TimeUnit;


/**
 * ConnectionManager 接口定义了连接管理器的功能，用于管理和调度到Redis集群或单节点的连接。
 */
public interface ConnectionManager {

    /**
     * 建立连接。
     */
    void connect() throws InterruptedException;

    /**
     * 获取订阅服务实例。
     */
    PublishSubscribeService getSubscribeService();

    /**
     * 获取最后一个集群节点的RedisURI。
     */
    RedisURI getLastClusterNode();

    /**
     * 检查是否以集群模式运行。
     */
    boolean isClusterMode();

    /**
     * 根据键计算槽的位置。
     */
    int calcSlot(String key);

    /**
     * 根据键计算槽的位置。
     */
    int calcSlot(byte[] key);

    /**
     * 获取所有MasterSlaveEntry的集合。
     */
    Collection<MasterSlaveEntry> getEntrySet();

    /**
     * 根据名称获取MasterSlaveEntry。
     */
    MasterSlaveEntry getEntry(String name);

    /**
     * 根据槽的位置获取写入操作的MasterSlaveEntry。
     */
    MasterSlaveEntry getWriteEntry(int slot);

    /**
     * 根据槽的位置获取读取操作的MasterSlaveEntry。
     */
    MasterSlaveEntry getReadEntry(int slot);

    /**
     * 根据地址获取MasterSlaveEntry。
     */
    MasterSlaveEntry getEntry(InetSocketAddress address);

    /**
     * 根据RedisURI获取MasterSlaveEntry。
     */
    MasterSlaveEntry getEntry(RedisURI addr);













    /**
     * 根据节点类型和地址创建Redis客户端。
     * @param type 节点类型（主节点或从节点）。
     * @param address 节点的Socket地址。
     * @param uri 节点的RedisURI。
     * @param sslHostname 安全套接字层主机名。
     * @return RedisClient 创建的Redis客户端实例。
     */
    RedisClient createClient(NodeType type, InetSocketAddress address, RedisURI uri, String sslHostname);

    /**
     * 根据RedisURI创建Redis客户端。
     * @param type 节点类型（主节点或从节点）。
     * @param address Redis节点的URI。
     * @param sslHostname 安全套接字层主机名。
     * @return RedisClient 创建的Redis客户端实例。
     */
    RedisClient createClient(NodeType type, RedisURI address, String sslHostname);





    /**
     * 根据Redis客户端获取对应的MasterSlaveEntry。
     * @param redisClient Redis客户端实例。
     * @return MasterSlaveEntry 对应的节点入口。
     */
    MasterSlaveEntry getEntry(RedisClient redisClient);






    /**
     * 关闭连接管理器，释放所有资源。
     */
    void shutdown();

    /**
     * 带有参数的关闭方法，允许指定静默期和超时时间。
     *
     * @param quietPeriod 静默期，即等待所有任务完成的时间。
     * @param timeout 超时时间。
     * @param unit 时间单位。
     */
    void shutdown(long quietPeriod, long timeout, TimeUnit unit);

    /**
     * 获取服务管理器实例。
     *
     * @return ServiceManager 服务管理器实例。
     */
    ServiceManager getServiceManager();

}
